blur-effect: Add some more documentation about performance

Explicitly mention that this effect works best for large blur radii and
can be slow if the blurred actor/image is large and not being scaled.

https://gitlab.gnome.org/GNOME/gnome-shell/merge_requests/991

diff --git a/src/shell-blur-effect.c b/src/shell-blur-effect.c
index 4a2f8f782fe7d3404c1001810f7a66ce728b0a91..7f1be6b1dfc8473aa6e86d084c06035d11098e4e 100644 (file)
--- a/src/shell-blur-effect.c
+++ b/src/shell-blur-effect.c
@@ -42,7 +42,9 @@
  * # Optimizations
  *
  * There are a number of optimizations in place to make this blur implementation
- * real-time.
+ * real-time. All in all, the implementation performs best when using large
+ * blur-radii that allow downscaling the texture to smaller sizes, at small
+ * radii where no downscaling is possible this can easily halve the framerate.
  *
  * ## Multipass
  *